Skip to content

docs(guide): update the framework overview & quickstart guides #4212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

docs(guide): update the framework overview & quickstart guides #4212

wants to merge 20 commits into from

Conversation

brandyscarney
Copy link
Member

@brandyscarney brandyscarney commented Jul 22, 2025 •
edited
Loading

This PR updates the intro guides for Angular, React and Vue to be more consistent among them. It updates the resource section on the overview to use improved icons and consistently link off to other sections. It also adds cards to the end of the quickstart. More about what was done:

  • Overview has been completely redone on all frameworks to be consistent and have an improved resources section (see below)
  • Quickstart has been added for Angular and redone for React and Vue to simplify the examples and bring them up to date
    • Part of the Vue Quickstart was moved to Build Options as it did not make sense there
    • I reordered Build Options under the Build Your First App for Angular & Vue as it makes more sense that Build Your First App would come right after the Quickstart
  • Performance / Platform files were updated just for syntax errors / titles

Screencaps

Overview

Before After
Angular Before Angular After
React Before React After
Vue Before Vue After

Previews

Overview

Quickstart

Build Options

  • Vue Build Options: No Before / After

Testing v6 changes locally

  • Open versions.json and add "v6" after "v7"
  • Open versionsArchived.json and remove the "v6" line
  • Open versioned_docs/version-v6/developer-resources/books.md and remove the extra : in (https:://developer.school)
  • Run npm start and the v6 dropdown should work

@vercel Vercel
Copy link

vercel bot commented Jul 22, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ionic-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2025 7:31pm

brandyscarney
brandyscarney commented Aug 7, 2025
View reviewed changes
docs/vue/build-options.md
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was moved here from Quickstart

@brandyscarney
Copy link
Member Author

@rdlabo I made quite a few changes here. Would you be able to update the JP docs with the same changes after this is merged? I think the deleted files will cause the JP docs build to fail until it's updated.

@brandyscarney brandyscarney marked this pull request as ready for review August 7, 2025 19:33
@brandyscarney brandyscarney requested a review from a team as a code owner August 7, 2025 19:33
@brandyscarney brandyscarney requested review from gnbm and ShaneK August 7, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gnbm gnbm Awaiting requested review from gnbm gnbm is a code owner automatically assigned from ionic-team/framework

@ShaneK ShaneK Awaiting requested review from ShaneK

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@brandyscarney @ShaneK